Retrieve automated shipwell events

SecurityAuthToken
Request
path Parameters
shipmentId
required
string <uuid>

The id of the shipment

query Parameters
page
integer

indicates what page of a list of query results you want to view

page-size
integer

indicates the how many items to return per page in a list request

ordering
string

determines which column to sort by. Prepend with '-' to sort desc

Responses
200

Retrieved events

Response Schema: application/json
page_size
integer
Array of objects (AutomationEvent)
total_count
integer
total_pages
integer
default

Default error response

get/shipments/{shipmentId}/automation/events/
Request samples 
Response samples 
application/json
{
  • "page_size": 0,
  • "results": [
    ],
  • "total_count": 0,
  • "total_pages": 0
}
Copyright © Shipwell 2024. All right reserved.